@feathersjs/commons

What is @feathersjs/commons?

@feathersjs/commons is a utility library for the Feathers framework, providing a set of common utilities and helper functions that can be used across different parts of a Feathers application. These utilities help with various tasks such as object manipulation, promise handling, and other common programming patterns.

What are @feathersjs/commons's main functionalities?

Object manipulation

The @feathersjs/commons package provides utilities for object manipulation, such as picking specific properties from an object.

const { _ } = require('@feathersjs/commons');

const obj = { a: 1, b: 2, c: 3 };
const picked = _.pick(obj, 'a', 'c');
console.log(picked); // { a: 1, c: 3 }

Promise handling

The package includes utilities for handling promises, such as converting callback-based functions to promise-based ones using `promisify`.

const { promisify } = require('@feathersjs/commons');

const callbackFunction = (data, callback) => {
  setTimeout(() => callback(null, data), 1000);
};

const promiseFunction = promisify(callbackFunction);

promiseFunction('Hello, world!').then(result => console.log(result)); // 'Hello, world!'

Deep object merging

The package provides utilities for deep merging of objects, which is useful for combining configuration objects or state.

const { merge } = require('@feathersjs/commons');

const obj1 = { a: 1, b: { c: 2 } };
const obj2 = { b: { d: 3 }, e: 4 };
const merged = merge({}, obj1, obj2);
console.log(merged); // { a: 1, b: { c: 2, d: 3 }, e: 4 }

Other packages similar to @feathersjs/commons

lodash

Lodash is a popular utility library that provides a wide range of functions for common programming tasks, including object manipulation, array operations, and more. It is more comprehensive and widely used compared to @feathersjs/commons.

bluebird

Bluebird is a fully-featured promise library that provides powerful extensions to the native JavaScript promises. It offers more advanced promise handling capabilities compared to the promise utilities in @feathersjs/commons.

deepmerge

Deepmerge is a library specifically designed for deep merging of JavaScript objects. It is more focused and specialized for this task compared to the general utilities provided by @feathersjs/commons.

README

Feathers Commons

Shared Feathers utility functions

Installation

npm install @feathersjs/commons --save

Documentation

Refer to the Feathers API for more details.

License

Copyright (c) 2024 Feathers contributors

Licensed under the MIT license.

Changelog

5.0.32 (2025-02-01)

Bug Fixes

• generators: Add FeathersGeneratorError (#3556) (2a81a20)